package com.zenithmind.document.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.zenithmind.document.pojo.domain.DocumentShare;
import com.zenithmind.document.pojo.dto.DocumentShareCreateDTO;
import com.zenithmind.document.pojo.dto.DocumentShareUpdateDTO;
import com.zenithmind.document.pojo.query.DocumentShareQueryDTO;
import com.zenithmind.document.pojo.vo.DocumentShareVO;

import java.util.List;

/**
 * 文档分享服务接口
 * 
 * @author ZenithMind Team
 * @since 2025-01-09
 */
public interface DocumentShareService extends IService<DocumentShare> {

    /**
     * 创建分享
     * 
     * @param createDTO 创建信息
     * @return 分享信息
     */
    DocumentShareVO createShare(DocumentShareCreateDTO createDTO);

    /**
     * 更新分享
     * 
     * @param id 分享ID
     * @param updateDTO 更新信息
     * @return 是否成功
     */
    Boolean updateShare(String id, DocumentShareUpdateDTO updateDTO);

    /**
     * 删除分享
     * 
     * @param id 分享ID
     * @return 是否成功
     */
    Boolean deleteShare(String id);

    /**
     * 批量删除分享
     * 
     * @param ids 分享ID列表
     * @return 是否成功
     */
    Boolean batchDeleteShares(List<String> ids);

    /**
     * 分页查询分享
     * 
     * @param queryDTO 查询条件
     * @return 分页结果
     */
    IPage<DocumentShareVO> getSharePage(DocumentShareQueryDTO queryDTO);

    /**
     * 获取分享详情
     * 
     * @param id 分享ID
     * @return 分享详情
     */
    DocumentShareVO getShareDetail(String id);

    /**
     * 根据分享码获取分享信息
     * 
     * @param shareCode 分享码
     * @return 分享信息
     */
    DocumentShareVO getShareByCode(String shareCode);

    /**
     * 获取文档分享列表
     * 
     * @param documentId 文档ID
     * @param includeExpired 是否包含过期的分享
     * @return 分享列表
     */
    List<DocumentShareVO> getDocumentShares(String documentId, Boolean includeExpired);

    /**
     * 获取用户分享列表
     * 
     * @param sharerId 分享者ID
     * @param limit 限制数量
     * @return 分享列表
     */
    List<DocumentShareVO> getUserShares(String sharerId, Integer limit);

    /**
     * 搜索分享
     * 
     * @param keyword 关键词
     * @param limit 限制数量
     * @return 分享列表
     */
    List<DocumentShareVO> searchShares(String keyword, Integer limit);

    /**
     * 获取热门分享
     * 
     * @param limit 限制数量
     * @return 分享列表
     */
    List<DocumentShareVO> getHotShares(Integer limit);

    /**
     * 验证分享访问权限
     * 
     * @param shareCode 分享码
     * @param password 密码
     * @return 是否有权限
     */
    Boolean validateShareAccess(String shareCode, String password);

    /**
     * 访问分享
     * 
     * @param shareCode 分享码
     * @param password 密码
     * @param userId 用户ID
     * @return 分享信息
     */
    DocumentShareVO accessShare(String shareCode, String password, String userId);

    /**
     * 下载分享文档
     * 
     * @param shareCode 分享码
     * @param password 密码
     * @param userId 用户ID
     * @return 文件数据
     */
    byte[] downloadSharedDocument(String shareCode, String password, String userId);

    /**
     * 记录分享访问
     * 
     * @param shareId 分享ID
     * @param accessType 访问类型
     * @param userId 用户ID
     * @return 是否成功
     */
    Boolean recordShareAccess(String shareId, String accessType, String userId);

    /**
     * 复制分享
     * 
     * @param sourceShareId 源分享ID
     * @param newTitle 新标题
     * @return 新分享信息
     */
    DocumentShareVO copyShare(String sourceShareId, String newTitle);

    /**
     * 禁用文档的所有分享
     * 
     * @param documentId 文档ID
     * @return 是否成功
     */
    Boolean disableDocumentShares(String documentId);

    /**
     * 更新过期分享状态
     * 
     * @return 更新数量
     */
    Integer updateExpiredShares();

    /**
     * 获取分享统计信息
     * 
     * @param shareId 分享ID
     * @return 统计信息
     */
    DocumentShareVO getShareStatistics(String shareId);

    /**
     * 获取分享访问记录
     * 
     * @param shareId 分享ID
     * @param limit 限制数量
     * @return 访问记录
     */
    List<Object> getShareAccessLogs(String shareId, Integer limit);

    /**
     * 生成分享链接
     * 
     * @param shareCode 分享码
     * @return 分享链接
     */
    String generateShareUrl(String shareCode);

    /**
     * 检查分享码是否存在
     * 
     * @param shareCode 分享码
     * @param excludeId 排除的分享ID
     * @return 是否存在
     */
    Boolean checkShareCodeExists(String shareCode, String excludeId);
}
